home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xext / XReadDisplayQueryExtension.z / XReadDisplayQueryExtension
Encoding:
Text File  |  2002-10-03  |  10.0 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXRRRREEEEAAAADDDDDDDDIIIISSSSPPPPLLLLAAAAYYYY((((3333XXXX11111111))))  XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666))))   XXXXRRRREEEEAAAADDDDDDDDIIIISSSSPPPPLLLLAAAAYYYY((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XReadDisplayQueryExtension, XReadDisplayQueryVersion,
  10.           XReadDisplay, XShmCreateReadDisplayBuf,
  11.           XShmReadDisplayRects, XShmDestroyReadDisplayBuf - X
  12.           readdisplay functions
  13.  
  14.      SSSSYYYYNNNNTTTTAAAAXXXX
  15.           #include <X11/extensions/readdisplay.h>
  16.  
  17.           Bool XReadDisplayQueryExtension (
  18.                Display *dpy,
  19.                int *event_basep,
  20.                int *error_basep);
  21.  
  22.           Status XReadDisplayQueryVersion (
  23.                Display *dpy,
  24.                int *major_versionp,
  25.                int *minor_versionp);
  26.  
  27.           XImage *XReadDisplay (
  28.                Display *dpy,
  29.                Window src,
  30.                int x,
  31.                int y,
  32.                unsigned int w,
  33.                unsigned int h,
  34.                unsigned long hints,
  35.                unsigned long *hints_return);
  36.  
  37.           ShmReadDisplayBuf *XShmCreateReadDisplayBuf (
  38.                Display *dpy,
  39.                char *data,
  40.                XShmSegmentInfo *shminfo,
  41.                int  width,
  42.                int  height);
  43.  
  44.           Status XShmReadDisplayRects (
  45.                Display *dpy,
  46.                Window src,
  47.                XRectangle *pRects,
  48.                int  nRects,
  49.                ShmReadDisplayBuf *shmbuf,
  50.                int  dstx,
  51.                int  dsty,
  52.                unsigned long  hints,
  53.                unsigned long *hints_return );
  54.  
  55.           void XShmDestroyReadDisplayBuf (
  56.                ShmReadDisplayBuf *shmbuf);
  57.  
  58.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  59.           _d_p_y       Specifies the connection to the X server.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXRRRREEEEAAAADDDDDDDDIIIISSSSPPPPLLLLAAAAYYYY((((3333XXXX11111111))))  XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666))))   XXXXRRRREEEEAAAADDDDDDDDIIIISSSSPPPPLLLLAAAAYYYY((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           _s_r_c       Specifies the window from whose screen you want to
  75.                     read data.
  76.  
  77.           _x
  78.           _y
  79.           _w
  80.           _h         Specify the area of the screen you want to read
  81.                     data from.
  82.  
  83.           _h_i_n_t_s     Specifies hints used by the server in reading the
  84.                     screen.  The server is free to ignore any and all
  85.                     of these.
  86.  
  87.           _h_i_n_t_s__r_e_t_u_r_n
  88.                     If non-NULL, returns the hints the server actually
  89.                     used.
  90.  
  91.           _d_a_t_a      Pointer to a shared memory buffer. It can be NULL
  92.                     if the shared memory buffer has not been allocated
  93.                     yet.
  94.  
  95.           _s_h_m_i_n_f_o   Pointer to a shared memory segment. (See MIT X
  96.                     Shared Memory extension)
  97.  
  98.           _h_e_i_g_h_t    Specifies the size of the shared memory buffer.
  99.  
  100.           _p_R_e_c_t_s    Specifies a list of rectangles to identify areas
  101.                     of the screen you want to read from.
  102.  
  103.           _n_R_e_c_t_s    Specifies the number of rectangles in the list.
  104.  
  105.           _s_h_m_b_u_f    Pointer to a shared memory buffer destination for
  106.                     the data.
  107.  
  108.           _d_s_t_x
  109.           _d_s_t_y      Specify the location in the shared memory buffer
  110.                     where the data is to be copied.
  111.  
  112.  
  113.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  114.           This man page describes the _X_1_1 _R_e_a_d _D_i_s_p_l_a_y _E_x_t_e_n_s_i_o_n,
  115.           _v_e_r_s_i_o_n _1._0 _a_n_d _v_e_r_s_i_o_n _1._1.  Version 1.0 does not support
  116.           the shared memory functions.  This extension allows client
  117.           programs to read device independent image information from
  118.           the screen.
  119.  
  120.           _X_R_e_a_d_D_i_s_p_l_a_y returns a pointer to an XImage structure
  121.           containing 32 bit pixel values for the information in the
  122.           specified box on the screen.  The XImage is in ZPixmap
  123.           format, with 8 bits per color component.  The high 8 bits of
  124.           the pixel value are defined to be zero unless otherwise
  125.           specified by the _h_i_n_t_s.  Any pixels which can not be read
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXRRRREEEEAAAADDDDDDDDIIIISSSSPPPPLLLLAAAAYYYY((((3333XXXX11111111))))  XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666))))   XXXXRRRREEEEAAAADDDDDDDDIIIISSSSPPPPLLLLAAAAYYYY((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           (either because they are off-screen, or because of layering
  141.           considerations) are defined to be zero.
  142.  
  143.           To use the shared memory version of ReadDisplay the user
  144.           should create a shared memory buffer using
  145.           _X_S_h_m_C_r_e_a_t_e_R_e_a_d_D_i_s_p_l_a_y_B_u_f().  The returned value is a
  146.           descriptor for the shared memory buffer.  After the buffer
  147.           is created the shared memory segment must be created and
  148.           attached using _s_h_m_g_e_t(_2) and _s_h_m_a_t(_2).  The next step for
  149.           the application is to tell the X Server to attach the shared
  150.           memory segment. To do so, you should use _X_S_h_m_A_t_t_a_c_h() (from
  151.           the MIT Shared Memory extension).
  152.  
  153.           To use X ReadDisplay with a shared memory buffer the
  154.           application has to call _X_S_h_m_R_e_a_d_D_i_s_p_l_a_y_R_e_c_t_s() passing a
  155.           rectangle list of the area on the screen that is to be
  156.           captured.  The data will be returned in the shared memory
  157.           buffer.  The format of the returned data is the same as for
  158.           the non-shared memory version.
  159.  
  160.           When finished using the shared memory buffer, it should be
  161.           freed by calling _X_S_h_m_D_e_s_t_r_o_y_R_e_a_d_D_i_s_p_l_a_y_B_u_f().
  162.  
  163.  
  164.  
  165.      PPPPRRRREEEEDDDDEEEEFFFFIIIINNNNEEEEDDDD VVVVAAAALLLLUUUUEEEESSSS
  166.           _X_R_D__R_E_A_D__A_L_P_H_A
  167.                tells the server to read alpha planes into the upper 8
  168.                bits of the pixel value.
  169.  
  170.           _X_R_D__I_G_N_O_R_E__N_O_R_M_A_L__L_A_Y_E_R
  171.                tells the server to ignore windows in the normal layer.
  172.                This is the layer the root window is in.
  173.  
  174.           _X_R_D__T_R_A_N_S_P_A_R_E_N_T
  175.                tells the server to ignore pixels that are transparent,
  176.                and read the color value of underlying pixels.
  177.                Normally, transparent pixels are returned as if they
  178.                were visible.
  179.  
  180.           _X_R_D__R_E_A_D__P_O_I_N_T_E_R
  181.                tells the server to include the mouse pointer in the
  182.                returned image.
  183.  
  184.           The following hints apply for layered systems.  Pixels from
  185.           windows that are in ignored layers should be treated as if
  186.           they were transparent.  If an underlying pixel is
  187.           nonexistent (as in the case of a window obscuring one in a
  188.           higher layer), the pixel value is defined to be zero.
  189.  
  190.  
  191.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__0
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXRRRREEEEAAAADDDDDDDDIIIISSSSPPPPLLLLAAAAYYYY((((3333XXXX11111111))))  XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666))))   XXXXRRRREEEEAAAADDDDDDDDIIIISSSSPPPPLLLLAAAAYYYY((((3333XXXX11111111))))
  203.  
  204.  
  205.  
  206.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__1
  207.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__2
  208.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__3
  209.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__4
  210.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__5
  211.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__6
  212.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__7
  213.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__M_I_N_U_S__1
  214.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__M_I_N_U_S__2
  215.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__M_I_N_U_S__3
  216.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__M_I_N_U_S__4
  217.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__M_I_N_U_S__5
  218.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__M_I_N_U_S__6
  219.           _X_R_D__I_G_N_O_R_E__L_A_Y_E_R__M_I_N_U_S__7
  220.                These hints tell the server to ignore windows in the
  221.                specified layer.
  222.  
  223.           _N_o_t_e:  the following hints are a superset of the above hints
  224.           in the case where there are layers beyond the range -7 to
  225.           +7.
  226.  
  227.           _X_R_D__I_G_N_O_R_E__P_O_S_I_T_I_V_E__L_A_Y_E_R_S
  228.                tells the server to ignore windows in all layers above
  229.                layer zero.
  230.  
  231.           _X_R_D__I_G_N_O_R_E__N_E_G_A_T_I_V_E__L_A_Y_E_R_S
  232.                tells the server to ignore windows in all layers below
  233.                layer zero.
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 10/3/02)
  262.  
  263.  
  264.  
  265.